<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<html>
<head>
<title>sprox_hlp_c.html</title>
<!-- Source : c:/temp/springprox_api/sprox_hlp.c -->
<!-- Doc generated on Thu Jun 24 12:26:29 2010 by johann on PC_DEV_5 -->
<!-- Generated with ROBODoc Version 4.99.8 (Specific build by PRO ACTIVE - Apr 13 2010) -->
<style type="text/css">
body
{
  background-color: #ffffff;
  color: #000000;
  font-family: Verdana, Geneva, Lucida, Arial, Helvetica, sans-serif;
  font-size: 9pt;
  margin-left: 60px;
  margin-right: 40px;  
}
table
{
  border-collapse: collapse;
  border-style: solid;
  border-width: 1px;
  border-color: #000000;
  margin-bottom: 12px;
}
td
{
  font-family: Verdana, Geneva, Lucida, Arial, Helvetica, sans-serif;
  font-size: 9pt;
  vertical-align: top;
  padding-right: 6px;
  border-style: solid;
  border-width: 1px;
  border-color: #dddddd; 
}
th
{
  font-family: Verdana, Geneva, Lucida, Arial, Helvetica, sans-serif;
  font-size: 9pt;
  vertical-align: top;  
  padding-right: 6px;
  border-style: solid;
  border-width: 1px;
  border-color: #000000;
  background-color: #dddddd;  
}
h1
{
  font-family: Verdana, Geneva, Lucida, Arial, Helvetica, sans-serif;
  font-size: 18pt;
  font-weight: bold;
  margin-bottom: 36px;
  color: #000000;
  margin-left: -40px;
}
h2
{
  font-family: Verdana, Geneva, Lucida, Arial, Helvetica, sans-serif;
  font-size: 12pt;
  font-weight: bold;
  margin-top: 48px;
  margin-bottom: 24px;
  padding-top: 2px;
  padding-bottom: 2px;
  background-color: #dddddd;
  color: #000000;
  margin-left: -40px;
}
h3
{
  font-family: Verdana, Geneva, Lucida, Arial, Helvetica, sans-serif;
  font-size: 11pt;
  font-weight: bold;
  margin-top: 36px;
  margin-bottom: 24px; 
  border-style: none;
  border-top-style: solid;  
  border-width: 1px;
  border-color: #cccccc; 
  margin-left: -40px;
}
h4
{
  font-family: Verdana, Geneva, Lucida, Arial, Helvetica, sans-serif;
  font-size: 11pt;
  font-weight: bold;
  margin-top: 24px;
  margin-bottom: 12px;  
}
h5
{
  font-family: Verdana, Geneva, Lucida, Arial, Helvetica, sans-serif;
  font-size: 9pt;
  font-weight: bold;
  margin-top: 12px;
  margin-bottom: 2px;  
}
a
{
  color: #0000ff;
}
p
{
  margin-top: 0px;
  margin-bottom: 6px;  
  width: 600px;
  text-align: justify;
}
ul
{
  margin-top: 0px;
  margin-bottom: 6px;  
  width: 600px;
  text-align: justify;
}
li
{
  margin-top: 0px;
  margin-bottom: 6px;  
  width: 550px;
  text-align: justify;
}
tt
{
  font-family: Courier, Courier New;
  font-size: 10pt;
}
pre
{
  background-color: #ffffff;
  color: #000000;
  font-size: 10pt;
}
.NAV
{
  font-size: 7pt;
}
a.NAV
{
  color: #0000cc;
}
.TOC
{
  font-size: 9pt;
  color: #888888;
}
a.TOC
{
  color: #0000ff;
}
.INDEX
{
  font-size: 9pt;
}
a.INDEX
{
  color: #0000ff;
}
.TYPE
{
  font-size: 7pt;
  color: #888888;
}
.ITEM
{
  font-weight: bold;
  color: #000088;
}
.LABEL
{
  color: #000088;
}
.HISTORY
{
  color: #006600;
}
.AUTHOR
{
  color: #006600;
}
.COPYRIGHT
{
  color: #006600;
}
.PORTABILITY
{
  color: #006600;
}
.WARNING
{
  color: #aa0000;
}

.bitinfo
{
  width: 60px;
  font-style: italic;
  text-align: center;
}

.bitnum
{
  text-align: center;
}

.bitname
{
  font-weight: bold;
  text-align: center;
}

.tabitem
{
  width: 100px;
}

.tabname
{
  width: 200px;
}

.tabdesc
{
  width: 450px;
}

.value
{
  font-family: courier;
  text-align: right;
}

.tabsepar
{
  border-top-style: solid;
  border-bottom-style: solid;
  border-width: 2px;
  border-color: #888888;
  font-style: italic;
  text-align: center;
}
</style>
</head>
<body bgcolor="#FFFFFF">
<a name="robo_top_of_doc"></a>
<h3 align="center">TABLE OF CONTENTS</h3>
<ul>
<li><a class="TOC" href="#robo23">SPROX_ArrayToString</a></li>
<li><a class="TOC" href="#robo54">SPROX_Free</a></li>
<li><a class="TOC" href="#robo56">SPROX_GetErrorMessage</a></li>
<li><a class="TOC" href="#robo70">SPROX_Malloc</a></li>
<li><a class="TOC" href="#robo106">SPROX_StringToArray</a></li>
<li><a class="TOC" href="#robo107">SPROX_StrLen</a></li>
</ul>
<h3>&nbsp;</h3>


<h2><a name="robo23"><span class="TYPE">[Functions]</span><a class="LABEL" name="SPROX5fArrayToString">
SPROX_ArrayToString</a></h2>

<p class="NAV">[<a class="NAV" href="#robo_top_of_doc">top</a>][<a class="NAV" href="./Copie de springprox_h.html#robo1">parent</a>][<a class="NAV" href="./functions.html#top">index</a>]</p>
<p class="ITEM">NAME</p>
<span class="NAME"><pre class="NAME">   <strong>SPROX_ArrayToString</strong>
</pre>
</span><p class="ITEM">DESCRIPTION</p>
<span class="DESCRIPTION"><pre class="DESCRIPTION">   Translate an array of bytes into a string of hexadecimal digits
</pre>
</span><p class="ITEM">INPUTS</p>
<span class="INPUTS"><pre class="INPUTS">   TCHAR *string      : buffer to hold the hexadecimal string
   const BYTE *buffer : byte array
   WORD size          : size of byte array
</pre>
</span><p class="ITEM">RETURNS</p>
<span class="RETURNS"><pre class="RETURNS">   MI_OK              : success
</pre>
</span><p class="ITEM">NOTES</p>
<span class="NOTES"><pre class="NOTES">   You must ensure that size of string buffer is enough to store
   the whole hexadecimal string (i.e. at least 2 * size characters)
</pre>
</span><p class="ITEM">VARIANTS</p>
<span class="VARIANTS"><pre class="VARIANTS">   SPROX_ArrayToStringA : ASCII version
   SPROX_ArrayToStringW : UNICODE version
</pre>
</span>


<h2><a name="robo54"><span class="TYPE">[Functions]</span><a class="LABEL" name="SPROX5fFree">
SPROX_Free</a></h2>

<p class="NAV">[<a class="NAV" href="#robo_top_of_doc">top</a>][<a class="NAV" href="./Copie de springprox_h.html#robo1">parent</a>][<a class="NAV" href="./functions.html#top">index</a>]</p>
<p class="ITEM">NAME</p>
<span class="NAME"><pre class="NAME">   <strong>SPROX_Free</strong>
</pre>
</span><p class="ITEM">DESCRIPTION</p>
<span class="DESCRIPTION"><pre class="DESCRIPTION">   Desallocation of a dynamic buffer
</pre>
</span><p class="ITEM">INPUTS</p>
<span class="INPUTS"><pre class="INPUTS">   BYTE *buffer       : address of the allocated buffer
</pre>
</span><p class="ITEM">RETURNS</p>
<span class="RETURNS"><pre class="RETURNS">   MI_OK              : success
</pre>
</span><p class="ITEM">SEE ALSO</p>
<span class="SEE_ALSO"><pre class="SEE ALSO">   <a class="LINK_37" href="#robo70">SPROX_Malloc</a>
</pre>
</span>


<h2><a name="robo56"><span class="TYPE">[Functions]</span><a class="LABEL" name="SPROX5fGetErrorMessage">
SPROX_GetErrorMessage</a></h2>

<p class="NAV">[<a class="NAV" href="#robo_top_of_doc">top</a>][<a class="NAV" href="./Copie de springprox_h.html#robo1">parent</a>][<a class="NAV" href="./functions.html#top">index</a>]</p>
<p class="ITEM">NAME</p>
<span class="NAME"><pre class="NAME">   <strong>SPROX_GetErrorMessage</strong>
</pre>
</span><p class="ITEM">DESCRIPTION</p>
<span class="DESCRIPTION"><pre class="DESCRIPTION">   Retrieve an english string explaining a function returned code
</pre>
</span><p class="ITEM">INPUTS</p>
<span class="INPUTS"><pre class="INPUTS">   SWORD status  : <a class="LINK_12" href="./springprox_h.html#robo0">SpringProxAPI</a> function returned value
</pre>
</span><p class="ITEM">RETURNS</p>
<span class="RETURNS"><pre class="RETURNS">   const TCHAR * : pointer to the translation string
</pre>
</span><p class="ITEM">WARNING</p>
<span class="WARNING"><pre class="WARNING">   The string returned is physically static in the <a class="LINK_28" href="./springprox_h.html#robo0">SpringProxAPI</a> address
   space. Do not try to change it nor to free the returned pointer.
</pre>
</span><p class="ITEM">VARIANTS</p>
<span class="VARIANTS"><pre class="VARIANTS">   SPROX_GetErrorMessageA : ASCII version
   SPROX_GetErrorMessageW : UNICODE version
</pre>
</span>


<h2><a name="robo70"><span class="TYPE">[Functions]</span><a class="LABEL" name="SPROX5fMalloc">
SPROX_Malloc</a></h2>

<p class="NAV">[<a class="NAV" href="#robo_top_of_doc">top</a>][<a class="NAV" href="./Copie de springprox_h.html#robo1">parent</a>][<a class="NAV" href="./functions.html#top">index</a>]</p>
<p class="ITEM">NAME</p>
<span class="NAME"><pre class="NAME">   <strong>SPROX_Malloc</strong>
</pre>
</span><p class="ITEM">DESCRIPTION</p>
<span class="DESCRIPTION"><pre class="DESCRIPTION">   Dynamic allocation of a buffer
</pre>
</span><p class="ITEM">INPUTS</p>
<span class="INPUTS"><pre class="INPUTS">   BYTE **buffer      : pointer to receive the address of the allocated buffer
   WORD size          : size of the buffer
</pre>
</span><p class="ITEM">RETURNS</p>
<span class="RETURNS"><pre class="RETURNS">   MI_OK              : success
</pre>
</span><p class="ITEM">NOTES</p>
<span class="NOTES"><pre class="NOTES">   The buffer must be freed using <a class="LINK_23" href="#robo54">SPROX_Free</a>
</pre>
</span>


<h2><a name="robo106"><span class="TYPE">[Functions]</span><a class="LABEL" name="SPROX5fStringToArray">
SPROX_StringToArray</a></h2>

<p class="NAV">[<a class="NAV" href="#robo_top_of_doc">top</a>][<a class="NAV" href="./Copie de springprox_h.html#robo1">parent</a>][<a class="NAV" href="./functions.html#top">index</a>]</p>
<p class="ITEM">NAME</p>
<span class="NAME"><pre class="NAME">   <strong>SPROX_StringToArray</strong>
</pre>
</span><p class="ITEM">DESCRIPTION</p>
<span class="DESCRIPTION"><pre class="DESCRIPTION">   Translate a string of hexadecimal digits into an array of bytes
</pre>
</span><p class="ITEM">INPUTS</p>
<span class="INPUTS"><pre class="INPUTS">   BYTE *buffer        : byte array to receive the result
   const TCHAR *string : hexadecimal string
   WORD size           : size of the byte array
</pre>
</span><p class="ITEM">RETURNS</p>
<span class="RETURNS"><pre class="RETURNS">   MI_OK              : success
</pre>
</span><p class="ITEM">NOTES</p>
<span class="NOTES"><pre class="NOTES">   The length of the string must be equals to 2 * size
</pre>
</span><p class="ITEM">VARIANTS</p>
<span class="VARIANTS"><pre class="VARIANTS">   SPROX_StringToArrayA : ASCII version
   SPROX_StringToArrayW : UNICODE version
</pre>
</span>


<h2><a name="robo107"><span class="TYPE">[Functions]</span><a class="LABEL" name="SPROX5fStrLen">
SPROX_StrLen</a></h2>

<p class="NAV">[<a class="NAV" href="#robo_top_of_doc">top</a>][<a class="NAV" href="./Copie de springprox_h.html#robo1">parent</a>][<a class="NAV" href="./functions.html#top">index</a>]</p>
<p class="ITEM">NAME</p>
<span class="NAME"><pre class="NAME">   <strong>SPROX_StrLen</strong>
</pre>
</span><p class="ITEM">DESCRIPTION</p>
<span class="DESCRIPTION"><pre class="DESCRIPTION">   Determines the length of a string
</pre>
</span><p class="ITEM">INPUTS</p>
<span class="INPUTS"><pre class="INPUTS">   const TCHAR *string : input string
</pre>
</span><p class="ITEM">RETURNS</p>
<span class="RETURNS"><pre class="RETURNS">   WORD : actual length (= number of characters) of the string
</pre>
</span><p class="ITEM">VARIANTS</p>
<span class="VARIANTS"><pre class="VARIANTS">   SPROX_StrLenA : ASCII version
   SPROX_StrLenW : UNICODE version
</pre>
</span>
<hr />
Generated from <b>sprox_hlp.c</b> on Thu Jun 24 12:26:29 2010<br />
</body>
</html>
